Skip to content

Improved the Slack integration documentation - #667

Merged
D-K-P merged 6 commits into
triggerdotdev:mainfrom
shelar1423:patch-4
Oct 23, 2023
Merged

Improved the Slack integration documentation #667
D-K-P merged 6 commits into
triggerdotdev:mainfrom
shelar1423:patch-4

Conversation

@shelar1423

Copy link
Copy Markdown
Contributor

Closes #663

✅ Checklist

  • I have followed every step in the contributing guide
  • The PR title follows the convention.
  • I ran and tested the code works

Testing

  • hosting it locally and making sure code works the way it is supposed to even after the change

Changelog

  • added Slack group with overview and auth , Tasks as subgroup
  • added slack-tasks file
  • formatted slack overview and auth page

Screenshots

image
image
image

💯

@changeset-bot

changeset-bot Bot commented Oct 20, 2023

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 2caa2a5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@shelar1423

Copy link
Copy Markdown
Contributor Author

@D-K-P have a review.Thank you

@D-K-P

D-K-P commented Oct 20, 2023

Copy link
Copy Markdown
Member

Thanks @shelar1423 just looking at the screenshots, there are a few typos (Plain is still there).

@shelar1423

shelar1423 commented Oct 20, 2023

Copy link
Copy Markdown
Contributor Author

@D-K-P done ✅, had clipped the plain doc for reference forgot to make that chnages,it done now have a look
image

@D-K-P

D-K-P commented Oct 20, 2023

Copy link
Copy Markdown
Member

Hey @shelar1423 - I will review this properly later today, but please make sure you're following the GitHub example. For example the OAuth section should explain how to use OAuth and also link to Slacks documentation so the user can check the scopes - github example here: https://trigger.dev/docs/integrations/apis/github

Also, for the overview, I've just improved GitHubs so it is a bit clearer. Basically we want to write about how you can use Slack with Trigger.dev - https://trigger.dev/docs/integrations/apis/github. Hope that helps!

@shelar1423

Copy link
Copy Markdown
Contributor Author

@D-K-P sure , meanwhile let me know if the other PR on Airtable is fine .

@shelar1423

Copy link
Copy Markdown
Contributor Author

UPDATED

@D-K-P
image
image

@D-K-P

D-K-P commented Oct 20, 2023

Copy link
Copy Markdown
Member

Thank you. Almost there:

  • The overview needs to describe what you can do with Slack and Trigger.dev, so in our case it is sending a messages to Slack
  • For the scopes link - here is an updated URL to change (the one you added was legacy): https://api.slack.com/scopes
  • For the task, please change the channel id to "< your-channel-id >"
  • Could you add a full example 'Example usage' at the bottom of tasks page (see the github docs for an example), you can use one from the jobs showcase

@shelar1423

Copy link
Copy Markdown
Contributor Author

@D-K-P sure will make the changes right now

@shelar1423

Copy link
Copy Markdown
Contributor Author

image

@D-K-P check if this is fine

@D-K-P
D-K-P merged commit 2d4f85e into triggerdotdev:main Oct 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[TRI-1429] Improve the Slack integration documentation

2 participants